/*
 * Copyright (c) 2024 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.helidon.tracing;

/**
 * Behavior of {@link io.helidon.tracing.Baggage} that can be updated.
 */
public interface WritableBaggage extends Baggage {

    /**
     * Adds a new or overrides an existing setting for the specified key using the provided value.
     *
     * @param key name of the entry to add or update
     * @param value value to assign to the entry
     * @return the baggage instance (for chained invocation)
     */
    WritableBaggage set(String key, String value);

    /**
     * Adds a new or overrides an existing setting for the specified key using the provided value and baggage metadata.
     *
     * @param key name of the entry to add or update
     * @param value value to assign to the entry
     * @param metadata metadata to assign to the entry
     * @return the baggage instance (for chained invocation)
     */
    default WritableBaggage set(String key, String value, String metadata) {
        return set(key, value);
    }
}
